Class Document

Dokumen

Dokumen, yang berisi satu atau beberapa objek Tab, yang masing-masing berisi rich text dan elemen seperti tabel dan daftar.

Dokumen dapat dibuka atau dibuat menggunakan DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Metode pada class Document yang secara langsung mengakses dan mengubah konten teks yang beroperasi di baik tab aktif (dalam skrip yang terikat dengan dokumen tertentu) atau tab pertama (jika tidak ada yang aktif). Skrip yang mengandalkan metode ini (misalnya, getBody()) dapat dimigrasikan ke tab dukungan menggunakan getTabs(), lalu Tab.asDocumentTab().

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
addBookmark(position)	Bookmark	Menambahkan Bookmark pada Position yang diberikan ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
addEditor(emailAddress)	Document	Menambahkan pengguna tertentu ke daftar editor untuk Document.
addEditor(user)	Document	Menambahkan pengguna tertentu ke daftar editor untuk Document.
addEditors(emailAddresses)	Document	Menambahkan array pengguna yang diberikan ke daftar editor untuk Document.
addFooter()	FooterSection	Menambahkan bagian footer, jika tidak ada, ke tab pertama atau tab aktif untuk skrip yang terikat ke dokumen.
addHeader()	HeaderSection	Menambahkan bagian header, jika tidak ada, ke tab pertama atau tab aktif untuk skrip yang terikat ke dokumen.
addNamedRange(name, range)	NamedRange	Menambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan pengambilan nanti, di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
addViewer(emailAddress)	Document	Menambahkan pengguna tertentu ke daftar pelihat untuk Document.
addViewer(user)	Document	Menambahkan pengguna tertentu ke daftar pelihat untuk Document.
addViewers(emailAddresses)	Document	Menambahkan array pengguna yang diberikan ke daftar pelihat untuk Document.
getActiveTab()	Tab	Mendapatkan Tab pengguna yang saat ini aktif dalam dokumen.
getAs(contentType)	Blob	Mengambil konten Document saat ini sebagai blob jenis yang ditentukan.
getBlob()	Blob	Mengambil konten Document saat ini sebagai blob.
getBody()	Body	Mengambil Body tab pertama atau, untuk skrip yang terikat dengan dokumen, DocumentBodySection tab aktif.
getBookmark(id)	Bookmark	Mendapatkan Bookmark dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
getBookmarks()	Bookmark[]	Mendapatkan semua objek Bookmark di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
getCursor()	Position	Mendapatkan kursor pengguna di tab aktif.
getEditors()	User[]	Mendapatkan daftar editor untuk Document ini.
getFooter()	FooterSection	Mengambil bagian footer tab pertama, atau, untuk skrip yang terikat dengan dokumen, footer tab aktif bagian.
getFootnotes()	Footnote[]	Mengambil semua elemen Footnote dalam isi tab pertama atau, untuk skrip yang terikat dengan dokumen, isi tab aktif.
getHeader()	HeaderSection	Mengambil bagian header tab pertama atau, untuk skrip yang terikat dengan dokumen, header tab aktif bagian.
getId()	String	Mengambil ID unik dokumen.
getLanguage()	String	Mendapatkan kode bahasa dokumen.
getName()	String	Mengambil judul dokumen.
getNamedRangeById(id)	NamedRange	Mendapatkan NamedRange dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
getNamedRanges()	NamedRange[]	Mendapatkan semua objek NamedRange di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
getNamedRanges(name)	NamedRange[]	Mendapatkan semua objek NamedRange dengan nama yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, yaitu tab aktif.
getSelection()	Range	Mendapatkan pilihan pengguna di tab aktif.
getSupportedLanguageCodes()	String[]	Mendapatkan semua kode bahasa yang didukung dalam file Google Dokumen.
getTab(tabId)	Tab	Mendapatkan Tab dengan ID yang ditentukan.
getTabs()	Tab[]	Mendapatkan semua Tab yang tidak bertingkat yang merupakan bagian dari dokumen.
getUrl()	String	Mengambil URL untuk mengakses dokumen saat ini.
getViewers()	User[]	Mendapatkan daftar pelihat dan pengomentar untuk Document ini.
newPosition(element, offset)	Position	Membuat Position baru, yang merupakan referensi ke lokasi di tab, yang terkait dengan elemen tertentu di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif.
newRange()	RangeBuilder	Membuat builder yang digunakan untuk membuat objek Range dari elemen tab di tab pertama, atau untuk skrip yang terikat dengan dokumen, tab aktif.
removeEditor(emailAddress)	Document	Menghapus pengguna tertentu dari daftar editor untuk Document.
removeEditor(user)	Document	Menghapus pengguna tertentu dari daftar editor untuk Document.
removeViewer(emailAddress)	Document	Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document.
removeViewer(user)	Document	Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document.
saveAndClose()	void	Menyimpan Document saat ini.
setActiveTab(tabId)	void	Menyetel Tab yang dipilih pengguna dalam dokumen saat ini ke tab dengan ID yang ditentukan.
setCursor(position)	Document	Menetapkan kursor pengguna, yang diberi Position.
setLanguage(languageCode)	Document	Menetapkan kode bahasa dokumen.
setName(name)	Document	Menetapkan judul dokumen.
setSelection(range)	Document	Menetapkan pilihan pengguna di tab aktif, dengan Range.

Dokumentasi mendetail

addBookmark(position)

Menambahkan Bookmark pada Position yang diberikan ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan bookmark ke tab mana pun, gunakan metode DocumentTab.addBookmark(position).

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

Parameter

Nama	Jenis	Deskripsi
position	Position	Posisi bookmark baru.

Pulang pergi

Bookmark — Bookmark baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addEditor(emailAddress)

Menambahkan pengguna tertentu ke daftar editor untuk Document. Jika pengguna sudah pada daftar penonton, metode ini mempromosikan pengguna tersebut dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
emailAddress	String	Alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addEditor(user)

Menambahkan pengguna tertentu ke daftar editor untuk Document. Jika pengguna sudah pada daftar penonton, metode ini mempromosikan pengguna tersebut dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
user	User	Representasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addEditors(emailAddresses)

Menambahkan array pengguna yang diberikan ke daftar editor untuk Document. Jika salah satu pengguna sudah ada di daftar, metode ini mempromosikan mereka dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
emailAddresses	String[]	Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addFooter()

Menambahkan bagian footer, jika tidak ada, ke tab pertama atau tab aktif untuk skrip yang terikat ke dokumen. Untuk menambahkan {i>footer<i} ke tab mana pun, gunakan metode DocumentTab.addFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addHeader()

Menambahkan bagian header, jika tidak ada, ke tab pertama atau tab aktif untuk skrip yang terikat ke dokumen. Untuk menambahkan header ke tab mana pun, gunakan metode DocumentTab.addHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addNamedRange(name, range)

Menambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan pengambilan nanti, di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk menambahkan NamedRange di tab mana pun, gunakan metode DocumentTab.addNamedRange(name, range). Nama bukan harus unik; beberapa rentang yang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti sebuah class dalam HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID di HTML. Setelah menambahkan NamedRange ke dokumen, Anda tidak dapat mengubahnya, Anda hanya dapat menghapusnya.

Setiap skrip yang mengakses dokumen dapat mengakses NamedRange. Untuk menghindari hal yang tidak diinginkan konflik antar skrip, pertimbangkan untuk memberi awalan pada nama rentang dengan string unik.

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parameter

Nama	Jenis	Deskripsi
name	String	Nama untuk rentang, yang tidak harus unik; nama rentang harus yang berisi antara 1-256 karakter.
range	Range	Rentang elemen yang akan dikaitkan dengan nama; rentangnya dapat berupa pilihan aktif, hasil penelusuran, atau dibuat secara manual dengan newRange().

Pulang pergi

NamedRange — NamedRange.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addViewer(emailAddress)

Menambahkan pengguna tertentu ke daftar pelihat untuk Document. Jika pengguna sudah pada daftar editor, metode ini tidak berpengaruh.

Parameter

Nama	Jenis	Deskripsi
emailAddress	String	Alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addViewer(user)

Menambahkan pengguna tertentu ke daftar pelihat untuk Document. Jika pengguna sudah pada daftar editor, metode ini tidak berpengaruh.

Parameter

Nama	Jenis	Deskripsi
user	User	Representasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

addViewers(emailAddresses)

Menambahkan array pengguna yang diberikan ke daftar pelihat untuk Document. Jika salah satu pengguna sudah ada di daftar editor, metode ini tidak berpengaruh bagi mereka.

Parameter

Nama	Jenis	Deskripsi
emailAddresses	String[]	Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getActiveTab()

Mendapatkan Tab pengguna yang saat ini aktif dalam dokumen. Skrip hanya dapat mengakses tab aktif pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

Pulang pergi

Tab — Tab pengguna yang saat ini aktif, atau null jika skrip tidak terikat ke dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getAs(contentType)

Mengambil konten Document saat ini sebagai blob jenis yang ditentukan.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Parameter

Nama	Jenis	Deskripsi
contentType	String	Jenis MIME yang menjadi tujuan konversi; 'application/pdf' dan 'text/markdown' didukung.

Pulang pergi

Blob — Dokumen saat ini sebagai blob.

---

getBlob()

Mengambil konten Document saat ini sebagai blob.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Pulang pergi

Blob — Dokumen saat ini sebagai blob.

---

getBody()

Mengambil Body tab pertama atau, untuk skrip yang terikat dengan dokumen, DocumentBodySection tab aktif. Untuk mendapatkan DocumentBodySection dari tab mana pun, gunakan metode DocumentTab.getBody().

Tab dapat berisi jenis bagian yang berbeda (misalnya, HeaderSection, FooterSection). Bagian aktif untuk tab adalah Body.

Metode elemen dalam Document didelegasikan ke Body aktif.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Pulang pergi

Body — Bagian isi tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getBookmark(id)

Mendapatkan Bookmark dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk mendapatkan bookmark di tab mana pun, gunakan metode DocumentTab.getBookmark(id). Metode ini akan menampilkan null jika tidak ada Bookmark dalam tab.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parameter

Nama	Jenis	Deskripsi
id	String	ID untuk Bookmark.

Pulang pergi

Bookmark — Bookmark dengan ID yang diberikan, atau null jika tidak ada Bookmark ada dalam tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getBookmarks()

Mendapatkan semua objek Bookmark di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk mendapatkan semua bookmark di tab mana pun, gunakan metode DocumentTab.getBookmarks().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Pulang pergi

Bookmark[] — Array objek Bookmark di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getCursor()

Mendapatkan kursor pengguna di tab aktif. Skrip hanya dapat mengakses kursor pengguna yang menjalankan skrip, dan hanya jika skrip tersebut terikat ke dokumen.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Pulang pergi

Position — Representasi kursor pengguna, atau null jika pengguna tidak memiliki ditempatkan di tab atau jika skrip tidak terikat ke dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getEditors()

Mendapatkan daftar editor untuk Document ini.

Pulang pergi

User[] — Array pengguna dengan izin edit.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getFooter()

Mengambil bagian footer tab pertama, atau, untuk skrip yang terikat dengan dokumen, footer tab aktif bagian. Untuk mendapatkan bagian footer dari tab mana pun, gunakan metode DocumentTab.getFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getFootnotes()

Mengambil semua elemen Footnote dalam isi tab pertama atau, untuk skrip yang terikat dengan dokumen, isi tab aktif. Untuk mendapatkan semua catatan kaki di tab mana pun, gunakan metode DocumentTab.getFootnotes().

Panggilan ke getFootnotes menyebabkan iterasi pada elemen tab. Untuk tab besar, menghindari panggilan yang tidak perlu ke metode ini.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Pulang pergi

Footnote[] — Catatan kaki tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getHeader()

Mengambil bagian header tab pertama atau, untuk skrip yang terikat dengan dokumen, header tab aktif bagian. Untuk mendapatkan bagian header dari tab mana pun, gunakan metode DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getId()

Mengambil ID unik dokumen. ID dokumen digunakan dengan DocumentApp.openById() untuk membuka instance dokumen tertentu.

Pulang pergi

String — ID dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getLanguage()

Mendapatkan kode bahasa dokumen. Ini adalah bahasa yang ditampilkan dalam opsi File-file editor dokumen &gt; Bahasa, yang mungkin bukan bahasa sebenarnya dalam dokumen.

Pulang pergi

String — Bahasa dokumen, atau null jika tidak ditentukan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getName()

Mengambil judul dokumen.

Pulang pergi

String — Judul dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getNamedRangeById(id)

Mendapatkan NamedRange dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk mendapatkan NamedRange dengan ID yang diberikan di tab mana pun, gunakan DocumentTab.getNamedRangeById(id) . Metode ini akan menampilkan null jika tidak ada NamedRange di tab. Nama belum tentu unik, bahkan di berbagai tab; beberapa rentang yang berbeda di tab yang sama mungkin memiliki nama yang sama, mirip seperti kelas pada HTML. Sebaliknya, ID bersifat unik di dalam tab, seperti ID di HTML.

Parameter

Nama	Jenis	Deskripsi
id	String	ID rentang yang bersifat unik dalam tab.

Pulang pergi

NamedRange — NamedRange dengan ID yang diberikan, atau null jika tidak ada rentang tersebut di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getNamedRanges()

Mendapatkan semua objek NamedRange di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk mendapatkan semua Objek NamedRange di tab mana pun, gunakan metode DocumentTab.getNamedRanges().

NamedRange dapat diakses oleh skrip apa pun yang mengakses tab. Untuk menghindari konflik yang tidak diinginkan di antara skrip, pertimbangkan untuk memberi awalan pada nama rentang dengan string unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab, mungkin termasuk beberapa rentang dengan nama yang sama.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getNamedRanges(name)

Mendapatkan semua objek NamedRange dengan nama yang diberikan di tab pertama atau, untuk skrip yang terikat dengan dokumen, yaitu tab aktif. Untuk mendapatkan semua objek NamedRange di tab mana pun, gunakan metode DocumentTab.getNamedRanges(name). Nama tidak harus unik, bahkan di berbagai tab; beberapa rentang yang berbeda dalam tab yang sama dapat memiliki nama yang sama, mirip seperti kelas di HTML. Sebaliknya, ID bersifat unik pada tab, seperti ID di HTML.

NamedRange dapat diakses oleh semua skrip yang mengakses dokumen. Untuk menghindari konflik yang tidak diinginkan di antara skrip, pertimbangkan untuk memberi awalan pada nama rentang dengan string unik.

Parameter

Nama	Jenis	Deskripsi
name	String	Nama rentang, yang belum tentu unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab dengan nama tertentu.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getSelection()

Mendapatkan pilihan pengguna di tab aktif. Skrip hanya dapat mengakses pilihan pengguna orang yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Pulang pergi

Range — Representasi pilihan pengguna, atau null jika pengguna tidak memiliki apa pun yang dipilih di tab, jika hanya akhir paragraf yang dipilih, jika hanya bagian akhir paragraf dan baris baru dipilih, atau jika skrip tidak terikat dengan dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getSupportedLanguageCodes()

Mendapatkan semua kode bahasa yang didukung dalam file Google Dokumen.

Pulang pergi

String[] — Array kode bahasa.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getTab(tabId)

Mendapatkan Tab dengan ID yang ditentukan. Metode ini akan menampilkan null jika Tab tidak ada. Dapat mengakses tab di level bertingkat apa pun.

Parameter

Nama	Jenis	Deskripsi
tabId	String	ID tab yang akan didapatkan.

Pulang pergi

Tab — Tab dengan ID yang ditentukan, atau null jika tidak ada Tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getTabs()

Mendapatkan semua Tab yang tidak bertingkat yang merupakan bagian dari dokumen.

Tab dapat berisi tab turunan, yaitu tab yang berada di dalam tab lain. Tab turunan dapat diakses menggunakan Tab.getChildTabs().

Pulang pergi

Tab[] — Daftar semua Tab yang merupakan bagian dari dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getUrl()

Mengambil URL untuk mengakses dokumen saat ini.

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Pulang pergi

String — URL untuk mengakses dokumen saat ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getViewers()

Mendapatkan daftar pelihat dan pengomentar untuk Document ini.

Pulang pergi

User[] — Array pengguna dengan izin lihat atau komentar.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

newPosition(element, offset)

Membuat Position baru, yang merupakan referensi ke lokasi di tab, yang terkait dengan elemen tertentu di tab pertama atau, untuk skrip yang terikat dengan dokumen, tab aktif. Untuk membuat Position relatif terhadap lokasi di tab mana pun, gunakan DocumentTab.newPosition(element, offset) . Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya.

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Nama	Jenis	Deskripsi
element	Element	Elemen yang harus berisi Position baru; ini harus berupa Text atau elemen penampung seperti Paragraph.
offset	Integer	Untuk elemen Text, jumlah karakter sebelum Position; untuk elemen lainnya, jumlah elemen turunan sebelum Position dalam elemen container yang sama.

Pulang pergi

Position — Position baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

newRange()

Membuat builder yang digunakan untuk membuat objek Range dari elemen tab di tab pertama, atau untuk skrip yang terikat dengan dokumen, tab aktif. Untuk membuat builder yang digunakan untuk membuat objek DocumentRange dari elemen tab di tab mana pun, gunakan metode DocumentTab.newRange().

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Pulang pergi

RangeBuilder — Builder baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

removeEditor(emailAddress)

Menghapus pengguna tertentu dari daftar editor untuk Document. Metode ini tidak blokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang telah akses umum—misalnya, jika Document dibagikan ke seluruh isi pengguna domain publik, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

Nama	Jenis	Deskripsi
emailAddress	String	Alamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

removeEditor(user)

Menghapus pengguna tertentu dari daftar editor untuk Document. Metode ini tidak blokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang telah akses umum—misalnya, jika Document dibagikan ke seluruh isi pengguna domain publik, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

Nama	Jenis	Deskripsi
user	User	Representasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

removeViewer(emailAddress)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document. Ini tidak berpengaruh jika pengguna adalah editor, bukan pelihat atau pengomentar. Metode ini juga tidak akan memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan ke seluruh domain, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

Nama	Jenis	Deskripsi
emailAddress	String	Alamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

removeViewer(user)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document. Ini tidak berpengaruh jika pengguna adalah editor, bukan pelihat. Metode ini juga tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses—misalnya, jika Document dibagikan ke seluruh domain pengguna, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

Nama	Jenis	Deskripsi
user	User	Representasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

saveAndClose()

Menyimpan Document saat ini. Menyebabkan update yang tertunda akan dihapus dan diterapkan.

Metode saveAndClose() secara otomatis dipanggil di akhir eksekusi skrip untuk setiap Document terbuka yang dapat diedit.

Document yang ditutup tidak dapat diedit. Gunakan DocumentApp.openById() untuk membuka kembali dokumen yang diberikan untuk diedit.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setActiveTab(tabId)

Menyetel Tab yang dipilih pengguna dalam dokumen saat ini ke tab dengan ID yang ditentukan.

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

Parameter

Nama	Jenis	Deskripsi
tabId	String	ID tab yang akan ditetapkan sebagai aktif.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setCursor(position)

Menetapkan kursor pengguna, yang diberi Position. Skrip hanya dapat mengakses kursor yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

Menyediakan Position dari Tab yang tidak aktif akan mengalihkan tab aktif pengguna.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Nama	Jenis	Deskripsi
position	Position	Lokasi kursor baru.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setLanguage(languageCode)

Menetapkan kode bahasa dokumen. Ini adalah bahasa yang ditampilkan dalam opsi File-file editor dokumen &gt; Bahasa, yang mungkin bukan bahasa sebenarnya dalam dokumen. Gunakan getSupportedLanguageCodes() untuk mendapatkan semua kode bahasa yang valid.

Parameter

Nama	Jenis	Deskripsi
languageCode	String	Kode bahasa.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setName(name)

Menetapkan judul dokumen.

Parameter

Nama	Jenis	Deskripsi
name	String	Judul dokumen baru.

Pulang pergi

Document — Dokumen saat ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setSelection(range)

Menetapkan pilihan pengguna di tab aktif, dengan Range. Skrip hanya dapat mengakses pilihan pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parameter

Nama	Jenis	Deskripsi
range	Range	Rentang elemen baru untuk dipilih.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents